# Rakenduse komponendi dokumentatsioon

Ühtsed nõuded rakenduse komponentide dokumenteerimisele. Sisaldab komponendi dokumentatsiooni standardeid. Suunatud arendajatele, arhitektidele ja projektijuhtidele.

## Kohustuslikud failid

Iga rakenduse komponent peab sisaldama järgmisi faile GIT repositooriumi juurkataloogis:

| Fail | Kohustuslik | Kirjeldus | Asukoht |
|------|-------------|------------|---------|
| **OpenAPI Spec** | REST teenused | API spetsifikatsioon | `openapi.yml` või `swagger.yml` |
| **README.md** | Kõik komponendid | Komponendi dokumentatsioon | Juurkataloog |
| **AGENTS.md** | Kõik komponendid | AI-agendi operatiivne kontekst (käivitamine, testid, stiil, mustrid) | Juurkataloog |
| **sonar.properties** | Kõik komponendid | SonarQube konfiguratsioon | Juurkataloog |

> **Märkused:**
>
> - UI komponendid võivad jätta vahele komponentjoonise

## Märkused

- README.md ja AGENTS.md peavad olema ajakohased ja vastama tegelikule rakendusele
- Dokumentatsioon ajakohastatakse iga major/minor versiooni väljalaskmisel
- Technical debt staatust hinnatakse kvartaalselt
- Kõik viited peavad olema töötavad ja õiged

---